GET api/SIMS/GetInvoiceStatus?tranRefs[0]={tranRefs[0]}&tranRefs[1]={tranRefs[1]}&companyKey={companyKey}

Gets a list of invoice statuses for a specific list of TranRef numbers

Request Information

URI Parameters

NameDescriptionTypeAdditional information
tranRefs

The list of TranRef numbers to be retrieved

Collection of string

Required

companyKey

The company name if the service is connected to multiple SIMS companies (Optional)

string

Default value is

Body Parameters

N/A


Response Information

Resource Description

List of invoice statuses. Returns errors if the invoices are not imported for the specific tran ref numbers, or imported if they were successful.

Collection of ApiTranStatus
NameDescriptionTypeAdditional information
TranNumber

The transaction number

string

N/A

Status

The status of the transaction

string

N/A

Response Formats

application/json, text/json

Sample:
[
  {
    "TranNumber": "sample string 1",
    "Status": "sample string 2"
  },
  {
    "TranNumber": "sample string 1",
    "Status": "sample string 2"
  }
]